home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1997 November / Macworld (1997-11).dmg / Updaters / Authorware 4 Components / Goodies / FileIO / FileIO Notes next >
Text File  |  1997-07-22  |  10KB  |  312 lines
  1. FileIO Xtra
  2. Version 1.0.2 - 18apr97 CH
  3.  
  4. FileIO Xtra for Macromedia Director 6.0
  5. =======================================
  6.  
  7. FileIO provides a set of methods allowing users of Macromedia Director 6.0 to
  8. programmatically access files using the Lingo scripting language. The FileIO
  9. Xtra is a scripting Xtra.  The scripting Xtra interface is portable across
  10. all Macromedia products.  Hence the FileIO Xtra may be used with Authorware 4.
  11.  
  12. Using FileIO
  13. ============
  14.  
  15. If automatic opening is desired, place a copy of the FileIO Xtra for your platform
  16. into Application Xtra's folder. If automatic opening is not desired, the Xtra can be 
  17. placed anywhere and opened using Lingo's 'openXLib' command. This applies to 
  18. projector's as well, the Xtra must be placed in an Xtra's folder in the same folder 
  19. as the projector.
  20.  
  21. Each instance of FileIO can reference a single open file. If multiple files are to
  22. be opened simultaneously, a new instance of FileIO is required for each opened file.
  23. A single instance can be used to open multiple files, as long as the file is closed
  24. before a new file is opened. To create a new instance, use the new() method, defined
  25. below. To dispose of an instance, set the instance variable to 0. All methods that
  26. read from or write to the file must be called after the file has been opened using
  27. the openFile() method. If a new file is to be opened using the same instance, the
  28. file must be closed using closeFile(). Files can be opened in three different modes:
  29. Read, Write and Read/Write. When writing to a file, the contents of the file after
  30. the current position are overwritten.
  31.  
  32. Example Lingo
  33.  
  34.  set myFile = new(xtra "fileio")      -- Create an instance of FileIO
  35.  set fileName = displayOpen(myFile)   -- Display Open Dialog and return the fileName
  36.  openFile(myFile, fileName, 1)        -- Open the file
  37.  set theFile = readFile(myFile)       -- Read the file and return a string to Lingo
  38.  closeFile(myFile)                    -- Close the file
  39.  set myFile = 0                       -- Dispose of the instance
  40.  
  41. In this example, we created a new instance and stored it in the variable myFile.
  42. Next, the displayOpen() method is used to display an open dialog to allow a file to
  43. be chosen. The file is returned as a fully-qualified path string to Lingo. The file
  44. is then opened in read only mode, the contents of the file are read, and the file is
  45. closed. Lastly, the instance is disposed of.
  46.  
  47. Known Problems
  48. ==============
  49.  
  50. The createFile() method does not support relative filenames, or the Lingo '@' 
  51. operator in pathnames. This will be fixed in a later version.
  52.  
  53. The displaySave() method does not directly inform Lingo whether a user is 
  54. replacing an existing file. The workaround is to attempt to create the file using
  55. createFile() and check the error code for a "File Already Exists" error.
  56.  
  57. History
  58. =======
  59.  
  60. 18apr97 (v1.0.2)
  61.  
  62. Fixed parenting problem with displaySave() and displayOpen() methods.
  63. Added support for Authorware.
  64.  
  65. 27may96 (v1.0.1)
  66.  
  67. Added support for double-byte character sets.
  68. Added version() method to report FileIO Xtra version information. 
  69. Added getOSDir() to return a full path to the Windows Directory/System Folder.
  70.  
  71. 15mar96 (v1.0.0 Beta)
  72.  
  73. First public release.
  74.  
  75. Method Reference
  76. ================
  77.  
  78. The first line of each definition contains the method name, a list of parameters and
  79. thier value types. The internal name of the FileIO Xtra is "fileio". This name is
  80. used whenever referencing the xtra using the form 'xtra "fileio"'.
  81.  
  82. Note that while Director and projector's can use net-based files by supplying a URL
  83. for a filename, the FileIO Xtra cannot. It is limited to accessesing files available
  84. via filesystems mounted on the local system.
  85.  
  86. New methods will appear at the bottom of this list.
  87.  
  88. ---
  89.  
  90. mMessageList( xtra reference )
  91.  
  92. Returns a list of methods and parameters, as well as a brief explanation of each.
  93.  
  94. ---
  95.  
  96. new( xtra reference )
  97.  
  98. This is called to create a new instance of FileIO. The Xtra can be referenced by name
  99. or number. It returns an instance variable used to reference the instance.
  100.  
  101. ---
  102.  
  103. fileName( instance )
  104.  
  105. Returns the fileName string of the current open file.  The file must be open use this
  106. method.
  107.  
  108. ---
  109.  
  110. status( instance )
  111.  
  112. Returns the error code returned by the last method called. The value is returned as
  113. an integer. 
  114.  
  115. ---
  116.  
  117. error( instance, int error )
  118.  
  119. Returns a readable error string. A numeric error code is passed in as the
  120. second argument. The errors returned can be any of the following:
  121.  
  122. "OK"
  123. "Memory allocation failure"
  124. "File directory full"
  125. "Volume full"
  126. "Volume not found"
  127. "I/O Error"
  128. "Bad file name"
  129. "File not open"
  130. "Too many files open"
  131. "File not found"
  132. "No such drive"
  133. "No disk in drive"
  134. "Directory not found"
  135. "Instance has an open file"
  136. "File already exists"
  137. "File is opened read-only"
  138. "File is opened write-only"
  139. "Unknown error"
  140.  
  141. ---
  142.  
  143. setFilterMask( instance, string mask )
  144.  
  145. Sets the filter mask used by calls to displayOpen() and displaySave(). The filter
  146. mask determines what files to show when displaying an Open or Save dialog. The second
  147. parameter is a string representing the filter mask to set. On Windows, this is a
  148. comma seperated string of file types and associated extensions (e.g. "All
  149. Files,*.*,Text Files,*.TXT"), and a string of types on the Macintosh (e.g.
  150. "TEXTPICT"). On Windows, the filter mask string is limited to 256 characters. On the
  151. Macintosh, you are limited to four four-character types.  When a new instance of
  152. FileIO is created, the filter masks defaults to all files. To reset the filter mask to
  153. display all files after it has been set, just pass in an empty string (e.g.
  154. setFilterMask(me, "")).
  155.  
  156. ---
  157.  
  158. openFile( instance, string fileName, int openMode )
  159.  
  160. Opens the named file. This call must be used before any read/write operations can
  161. take place. The filename can be either a fully-qualified path and filename, or a
  162. relative filename. The Lingo '@' pathname operator is supported. The openMode
  163. parameter specifies whether to open the file in Read, Write or ReadWrite mode. Valid
  164. Flags are: 0 Read/Write, 1 Read, 2 Write.
  165.  
  166. ---
  167.  
  168. closeFile( instance )
  169.  
  170. Closes a file that has been previously opened using the openFile() method.
  171.  
  172. ---
  173.  
  174. displayOpen( instance )
  175.  
  176. Displays a platform specific Open dialog allowing a user to specify a file. Returns a
  177. fully-qualified path and fileName to Lingo. The setFilterMask() method can be used to
  178. control what file types are displayed in the dialog.
  179.  
  180. ---
  181.  
  182. displaySave( instance, string title, string defaultFileName )
  183.  
  184. Displays a platform specific Save dialog allowing a user to specify a file. Returns a
  185. fully-qualified path and fileName to Lingo. The setFilterMask() method can be used to
  186. control what file types are displayed in the dialog. The string and defaultFileName 
  187. parameters allow you to specifiy a default filename to be displayed, as well as title
  188. text for the save dialog. 
  189.  
  190. ---
  191.  
  192. createFile( instance, string fileName )
  193.  
  194. Creates a file. The fileName must be either a fileName to be created in the current
  195. directory, or a fully-qualified path and fileName. The Lingo '@' pathname operator
  196. and relative paths are not supported. After creating the new file, the file must be
  197. opened before it can be written to.
  198.  
  199. ---
  200.  
  201. setPosition( instance, position )
  202.  
  203. Sets the file position of the current open file. The file must be open to use this 
  204. method.
  205.  
  206. ---
  207.  
  208. getPosition( instance )
  209.  
  210. Gets the file position of the current open file. Returned as an integer. The file
  211. must be open to use this method. 
  212.  
  213. ---
  214.  
  215. getLength( instance )
  216.  
  217. Gets the length of the currently opened file. Returned as an integer. The file must
  218. be open use this method. The value returned is the length of the file in bytes. 
  219.  
  220. ---
  221.  
  222. writeChar( instance, string theChar )
  223.  
  224. Writes a single character to the file at the current position. The file must be open
  225. in write or read/write mode to use this method.
  226.  
  227. ---
  228.  
  229. writeString( instance, string theString )
  230.  
  231. Writes a string to the file at the current position. The file must be open in write
  232. or read/write mode to use this method.
  233.  
  234. ---
  235.  
  236. readChar( instance )
  237.  
  238. Reads the character (either single or double-byte) at the current position and then 
  239. increments the position. The character is returned to Lingo as a string. The file must 
  240. be open in read or read/write mode to use this method. 
  241.  
  242. ---
  243.  
  244. readLine( instance )
  245.  
  246. Reads from the current position up to and including the next CR, increments the
  247. position, and returns the string to Lingo.  The file must be open in read or
  248. read/write mode to use this method. 
  249.  
  250. ---
  251.  
  252. readFile( instance )
  253.  
  254. Reads from the current position to the end of the file and returns the file to Lingo
  255. as a string.  The file must be open in read or read/write mode to use this method.
  256.  
  257. ---
  258.  
  259. readWord( instance )
  260.  
  261. Reads the next word starting at the current position.  The file must be open in read
  262. or read/write mode to use this method. 
  263.  
  264. ---
  265.  
  266. readToken( instance, string skipChar, string breakChar )
  267.  
  268. Reads the next 'token' starting at the current position. Characters matching the
  269. skipChar parameter are "skipped" and the file is read until breakChar is encountered.
  270. The file must be open in read or read/write mode to use this method. This method will
  271. read double-byte tokens as long as the skip and break are single-byte characters. It
  272. will not detect double-byte skip or break characters.
  273.  
  274. ---
  275.  
  276. getFinderInfo( instance )
  277.  
  278. Returns the Type and Creator of the current file as a string. This method does
  279. nothing when used under Windows.  The file must be open to use this method.
  280.  
  281. ---
  282.  
  283. setFinderInfo( instance, string typeAndCreator )
  284.  
  285. Sets the Type and Creator of the current file. The string takes the form of a space
  286. seperated set of TYPE and CREATOR codes (e.g. "TEXT TTXT"). This method does nothing
  287. when used under Windows.  The file must be open to use this method.
  288.  
  289. ---
  290.  
  291. delete( instance )
  292.  
  293. Deletes the currently opened file.  The file must be open use this method.
  294.  
  295. ---
  296.  
  297. version( xtraRef )
  298.  
  299. Returns FileIO version and build information. Useful when filing 
  300. bug reports, determining installed version while authoring, etc. No practical use beyond this.
  301.  
  302. ---
  303.  
  304. getOSDir( )
  305.  
  306. Global method that returns the full path to either the Windows directory, or the System Folder 
  307. depending on which OS is currently being used. Does not require a child instance or
  308. Xtra reference to call.
  309.  
  310. ---
  311.  
  312.